feat: Add Customer Configurable Standardization #53
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BrandonStalnaker
approved these changes
Sep 26, 2023
alexs-mparticle
requested changes
Sep 26, 2023
packages/GA4Client/src/common.js
Outdated
| name = window.GoogleAnalytics4Kit.setCustomNameStandardization(name); | ||
| } catch (e) { | ||
| console.warn( | ||
| 'Error calling setCustomNameStandardization callback. Check your callback. Data will still be sent without user-defined standardization', |
There was a problem hiding this comment.
Should we provide a link to our docsite? If not in the error log, perhaps we can provide a link to the docsite or example code as a comment?
There was a problem hiding this comment.
Haven't started the docs yet. But that's a good idea.
Comment on lines
26
to
30
| // Due to current limitations, the API for allowing a customer to cleanse | ||
| // their data before our cleansing occurs must be placed on the | ||
| // window.GoogleAnalytics4Kit object. This exists when initializing MP | ||
| // SDK via snippet, but not via npm. If a customer uses npm, using the API | ||
| // requires window.GoogleAnalytics4Kit to exist on the page. |
There was a problem hiding this comment.
The initial part is a little unclear. Does this make more sense?
Suggested change
| // Due to current limitations, the API for allowing a customer to cleanse | |
| // their data before our cleansing occurs must be placed on the | |
| // window.GoogleAnalytics4Kit object. This exists when initializing MP | |
| // SDK via snippet, but not via npm. If a customer uses npm, using the API | |
| // requires window.GoogleAnalytics4Kit to exist on the page. | |
| // To allow customers to cleanse their data before mParticle | |
| // internal cleansing occurs, we must add a simple API into the | |
| // window.GoogleAnalytics4Kit object. This object will be automatically | |
| // initialized when MP SDK initializes via snippet, but not via npm. | |
| // Customers using npm, a customer must manually add | |
| // window.GoogleAnalytics4Kit to the page themselves. |
Co-authored-by: Alex S <[email protected]>
alexs-mparticle
approved these changes
Sep 26, 2023
rmi22186
added a commit
that referenced
this pull request
Sep 29, 2023
github-actions bot
pushed a commit
that referenced
this pull request
Oct 2, 2023
# [1.3.0](v1.2.0...v1.3.0) (2023-10-02) ### Features * Add Customer Configurable Standardization ([#53](#53)) ([c851914](c851914))
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR allows a customer to pass a standardization callback for name that affects event name, custom attributes, and product attributes.
Testing Plan
Added unit tests. Tested locally.
The callback I used was to remove the last letter of each string.
Screen shot 1 shows a transaction sent with product attributes and custom attributes.
Note that
eventMetric1gets shortened toeventMetricin the payload.journeyType-->journeyTyp, andsale-->sal.Screenshot 2
Shows
name-->nam,abc-->ab, anddef-->de.Master Issue
Closes https://go.mparticle.com/work/SQDSDKS-5641